doc: Add search by compatibles in the board catalog #97557
Conversation
kartben
force-pushed
the
add_compatible_search
branch
2 times, most recently
from
cf56855 to
8d9057c
Compare
kartben
force-pushed
the
add_compatible_search
branch
6 times, most recently
from
7382538 to
fe9ac32
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds the ability to filter boards in the catalog by compatible strings, with support for wildcards. It enables users to quickly find boards containing specific devices (e.g., st,lsm* accelerometer) and adds cross-linking from binding documentation pages to boards using those compatibles.
Key Changes:
- Added compatible string collection and filtering to the board catalog
- Implemented wildcard pattern matching for compatible searches
- Added UI components for compatible string input with tag-based selection
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/_scripts/gen_devicetree_rest.py | Adds cross-reference link from binding documentation to board catalog filtered by compatible |
| doc/_scripts/gen_boards_catalog.py | Collects compatible strings from device tree nodes for each board target |
| doc/_extensions/zephyr/domain/templates/board-catalog.html | Adds new form field for compatible string filtering with wildcard support |
| doc/_extensions/zephyr/domain/templates/board-card.html | Adds data-compatibles attribute to board cards containing all compatible strings |
| doc/_extensions/zephyr/domain/static/js/board-catalog.js | Implements compatible filtering logic with wildcard matching and URL state management |
| doc/_extensions/zephyr/domain/static/css/board-catalog.css | Applies monospace font styling to compatible tags |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This commits adds a `compatibles` field to each board entry in the board catalog, similar to the `supported_features` field. Signed-off-by: Benjamin Cabé <[email protected]>
There might be different UI widgets that deal with tags so make sure that we use identifiers and selectors that are not too generic. Signed-off-by: Benjamin Cabé <[email protected]>
…alog This adds the ability to filter boards in the catalog by compatible strings. It supports wildcards so e.g. one can quickly find all boards with an "st,lsm*" accelerometer. Signed-off-by: Benjamin Cabé <[email protected]>
This adds a link to the board catalog in the sidebar of each binding page, directing users to boards using the compatible. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
add_compatible_search
branch
from
fe9ac32 to
7708494
Compare
|
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
kartben
requested review from
DerekSnell,
asmellby,
erwango,
fabiobaltieri and
pdgendt
|
@kartben Are |
@JarmouniA Yep! |
6 participants
This adds the ability to filter boards in the catalog by compatible strings. It supports wildcards so e.g. one can quickly find all boards with e.g. an
st,lsm*accelerometer.Search by compatible in the catalog
Cross-referencing boards from the documentation page of a binding
As a bonus, binding documentation also now has nice cross-linking to list of boards that use the compatible
Depends on (commits from these PRs are included in this PR until they are merged):